Announcement Element

This is the parcel announcement schema root. The parcel announcement is used to inform a social media branding partner about parcel(s) to be sent to a customer. The announcement email can be transferred by the social media partner into a nice looking email destined for a final customer.

Announcement

This is the parcel announcement schema root. The parcel announcement is used to inform a social media branding partner about parcel(s) to be sent to a customer. The announcement email can be transferred by the social media partner into a nice looking email destined for a final customer.

All

StoreInfo

This is the Retail3000 store who sent the parcel.

All

CompanyName xs:string

CompanyNumber xs:int

StoreName xs:string

StoreNumber xs:int

ContractNumber xs:int

The contractnumber from RetailVista can be used to recognize the customer where this parcel announcement came from. The contract number in general will never change.

ParcelInfo

Version required xs:string

All

ParcelPartnerType Restriction of xs:string

This element can be used to recognize the parcel partner type where a parcel is announced. When a parcel is announced at Post NL for example, there is a track and trace website where a customer can post the track and trace barcode, together with the zip code to track a parcel.

Use this element to determine the used parcel service, so correct hyperlinks can be used within the email message to the final customer.

Please keep in mind that we can't help with url's of parcel services. You can use trial and error, or just simply contact them.

DeliveryProductCode optional xs:string

A parcel service can use a productcode to indicate the requested treatment of a shipment to be sent. At Post NL for example, delivery product code 3085 means a regular 'normal' shipment. A shop has to sign a contract in wich they will agree about the possibly productcodes that they are allowed to use.

Please keep in mind that we can't help on the productcodes used by each parcel service partner. Contact them directly to get information about the codes being used.

InsuredValue optional xs:decimal

This is the insurance value of a parcel being sent. When the insurance value is not available, the parcel will not be (additionally) insured.

NumberOfParcels xs:int

The number of parcels being sent in this shipment. Shipments can exists of multi-collo's where each separate collo has it's own track and trace barcode. In the circumstance, there will be a MainParcelBarcode which indicates the barcode of the shipment itself.

MainParcelBarcode xs:string

When this is a multi-collo shipment, this is the track and trace barcode of the whole shipment.

ReservationNumber xs:int

This element contains the reservationnumber from Retail3000 which has led to this parcel.

CustomerReference xs:string

This element contains the customer reference text from Retail3000 which has led to this parcel. In case of webshop orders, this field will most likely contain the webshop order reference.

SendingCustomer SendingCustomer Complex Type

This element describes the customer who has sent this shipment.

Sequence

Name xs:string

Contact xs:string

Email xs:string

SendingAddress Address Complex Type

This element describes the address where this shipment originates from.

Sequence

Address xs:string

The complete address, including housenumber and additions.

AddressDescription xs:string

An optional filled text, describing the address. Especially used when no housenumber is available, for example on ships lying in canals.

AttentionOf xs:string

An optional filled text describing a person or department when delivery a parcel, for example 'logistics department'.

County xs:string

ZipCode xs:string

City xs:string

CountryDescription xs:string

CountryIsoCode xs:string

DestinationCustomer DestinationCustomer Complex Type

This element describes the destination customer where this shipment it sent to.

Sequence

CustomerNumber xs:long

Name xs:string

Email xs:string

CellPhone xs:string

LandLinePhone xs:string

DestinationAddress Address Complex Type

This element describes the address of the destination customer where this shipmet is sent to. When an AlternateDeliveryAddress is available, this address is for information only. In such case, the parcel will be sent to the give alternate delivery address.

Sequence

Address xs:string

The complete address, including housenumber and additions.

AddressDescription xs:string

An optional filled text, describing the address. Especially used when no housenumber is available, for example on ships lying in canals.

AttentionOf xs:string

An optional filled text describing a person or department when delivery a parcel, for example 'logistics department'.

County xs:string

ZipCode xs:string

City xs:string

CountryDescription xs:string

CountryIsoCode xs:string

AlternateDeliveryAddress optional Address Complex Type

This element describes the alternate delivery address of the destination customer where this shipment is sent to.

Sequence

Address xs:string

The complete address, including housenumber and additions.

AddressDescription xs:string

An optional filled text, describing the address. Especially used when no housenumber is available, for example on ships lying in canals.

AttentionOf xs:string

An optional filled text describing a person or department when delivery a parcel, for example 'logistics department'.

County xs:string

ZipCode xs:string

City xs:string

CountryDescription xs:string

CountryIsoCode xs:string

ParcelRows optional

Choice 0..∞

ParcelRow ParcelRowBase Complex Type

Each collo in a parcel shipment is identified separately by a parcel row.

Sequence

TrackTraceBarcode xs:string

This is the track and trace barcode given by a parcel service provider.

AnnouncementDateTime xs:dateTime

This is the date and time when a parcel was announced by Retail3000 at a parcel service partner.

<xs:element name="Announcement" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:all>
      <xs:element name="StoreInfo" minOccurs="1" maxOccurs="1">
        <xs:complexType>
          <xs:all>
            <xs:element name="CompanyName" type="xs:string" minOccurs="1" />
            <xs:element name="CompanyNumber" type="xs:int" minOccurs="1" />
            <xs:element name="StoreName" type="xs:string" minOccurs="1" />
            <xs:element name="StoreNumber" type="xs:int" minOccurs="1" />
            <xs:element name="ContractNumber" type="xs:int" minOccurs="1" />
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element name="ParcelInfo" minOccurs="1" maxOccurs="1">
        <xs:complexType>
          <xs:all>
            <xs:element name="ParcelPartnerType" minOccurs="1" maxOccurs="1">
              <xs:simpleType>
                <xs:restriction base="xs:string">
                  <xs:pattern value="RetailVista|PostNL|DPD|DHL|GLS" />
                </xs:restriction>
              </xs:simpleType>
            </xs:element>
            <xs:element name="DeliveryProductCode" type="xs:string" minOccurs="0" />
            <xs:element name="InsuredValue" type="xs:decimal" minOccurs="0" />
            <xs:element name="NumberOfParcels" type="xs:int" minOccurs="1" />
            <xs:element name="MainParcelBarcode" type="xs:string" minOccurs="1" />
            <xs:element name="ReservationNumber" type="xs:int" minOccurs="1" />
            <xs:element name="CustomerReference" type="xs:string" minOccurs="1" />
            <xs:element name="SendingCustomer" type="parcel:SendingCustomer" minOccurs="1" />
            <xs:element name="SendingAddress" type="parcel:Address" minOccurs="1" />
            <xs:element name="DestinationCustomer" type="parcel:DestinationCustomer" minOccurs="1" />
            <xs:element name="DestinationAddress" type="parcel:Address" minOccurs="1" />
            <xs:element name="AlternateDeliveryAddress" type="parcel:Address" minOccurs="0" />
          </xs:all>
          <xs:attribute name="Version" type="xs:string" use="required" />
        </xs:complexType>
      </xs:element>
      <xs:element name="ParcelRows" minOccurs="0" maxOccurs="1">
        <xs:complexType>
          <xs:choice minOccurs="0" maxOccurs="unbounded">
            <xs:element name="ParcelRow" type="parcel:ParcelRowBase" />
          </xs:choice>
        </xs:complexType>
      </xs:element>
    </xs:all>
  </xs:complexType>
</xs:element>

ParcelAnnouncement-v1.0 Schema